Skip to content

docs: Update gradle configuration readme #1359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 22 commits into from
Aug 24, 2023
Merged

docs: Update gradle configuration readme #1359

merged 22 commits into from
Aug 24, 2023

Conversation

scottgerring
Copy link
Contributor

@scottgerring scottgerring commented Aug 14, 2023 •
edited
Loading

Issue #, if available:
#1358 (Update gradle documentation)
#1067 (Improve example coverage)

Description of changes:

Updates README to provide up-to-date gradle build instructions for Java11+.

Checklist

Breaking change checklist

RFC issue #:

  • Migration process documented
  • Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@scottgerring scottgerring marked this pull request as ready for review August 14, 2023 06:45
@scottgerring scottgerring requested a review from jeromevdl August 14, 2023 06:45
@scottgerring
Copy link
Contributor Author

@jeromevdl looking at the issue and your PR for the templates, I think this is all we need?

@scottgerring scottgerring changed the title Docs: Update gradle configuration readme Doc: Update gradle configuration readme Aug 14, 2023
@scottgerring scottgerring changed the title Doc: Update gradle configuration readme docs: Update gradle configuration readme Aug 14, 2023
jeromevdl
jeromevdl reviewed Aug 15, 2023
View reviewed changes
jeromevdl
jeromevdl reviewed Aug 15, 2023
View reviewed changes
Copy link
Contributor

@jeromevdl jeromevdl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe give a try with a v8.0 of gradle not to force people to use the latest. Maybe mention to check their version with gradle -v or to update the version in the property file somewhere if they use the local gradlew.

@scottgerring
Copy link
Contributor Author

@jeromevdl i'll add a complete gradle example in powertools-examples-core like Alexey has done for the other /CD tools and use that to work it out.

@scottgerring scottgerring mentioned this pull request Aug 15, 2023
Closed
1 task
@scottgerring
Copy link
Contributor Author

Maybe give a try with a v8.0 of gradle not to force people to use the latest. Maybe mention to check their version with gradle -v or to update the version in the property file somewhere if they use the local gradlew.

This is a pain to try and debug, with the gradle wrapper and the caching of deps. Fortunately I found some wording on their website:

Unless otherwise noted, all plugins require at least Java 8 and are targeted at Gradle 8.2.1.

@codecov-commenter
Copy link

codecov-commenter commented Aug 16, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (7c3e45b) 78.93% compared to head (44ffa3e) 78.93%.
Report is 4 commits behind head on main.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files 
@@            Coverage Diff            @@
##               main    #1359   +/-   ##
=========================================
  Coverage     78.93%   78.93%           
  Complexity      652      652           
=========================================
  Files            74       74           
  Lines          2506     2506           
  Branches        259      259           
=========================================
  Hits           1978     1978           
  Misses          446      446           
  Partials         82       82

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@scottgerring
Copy link
Contributor Author

I've added a Gradle example, but for Java 8 only. It doesn't seem like there is an easy way to setup a JDK-independent gradle build like we have with maven, because the gradle wrapper itself needs to change depending on the JDK + aspect version.

@scottgerring scottgerring self-assigned this Aug 18, 2023
@scottgerring scottgerring linked an issue Aug 24, 2023 that may be closed by this pull request
Docs: Fix gradle build information #1358
Closed
1 task
scottgerring
scottgerring commented Aug 24, 2023
View reviewed changes
jeromevdl
jeromevdl reviewed Aug 24, 2023
View reviewed changes
Copy link
Contributor

@jeromevdl jeromevdl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

few comments...

@scottgerring scottgerring requested a review from jeromevdl August 24, 2023 13:25
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@scottgerring scottgerring merged commit 8d03249 into main Aug 24, 2023
@scottgerring scottgerring deleted the fix-gradle-build-info branch August 24, 2023 14:09
jeromevdl added a commit that referenced this pull request Oct 12, 2023
@scottgerring @jeromevdl
docs: Update gradle configuration readme (#1359)
7bbc40a 
* Update gradle configuration readme

* Move into configuration

* Starting gradle example

* Remove

* Start again

* Update documentation for gradle

* Clarify gradle versions a bit better

* Starting gradle example

* Cleanup gradle example

* Build gradle example

* Fix build hopefully

* Add gradle wrapper

* Formatting

* Update docs/index.md

Co-authored-by: Jérôme Van Der Linden <[email protected]>

* Apply suggestions from code review

Co-authored-by: Jérôme Van Der Linden <[email protected]>

* Updated README with sam instructions

---------

Co-authored-by: Jérôme Van Der Linden <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeromevdl jeromevdl jeromevdl approved these changes

Assignees

@scottgerring scottgerring

Labels
size/XL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Fix gradle build information
3 participants
@scottgerring @codecov-commenter @jeromevdl